GuiCommand model/fr

Other languages:
Cette page montre un modèle de page Gui Command. Sous la section Bloc sélectionnable ci-dessous, vous trouverez le même contenu que vous pouvez facilement sélectionner pour le coller dans une nouvelle page.
Commande avant
Commande après
Atelier

Modèle GuiCommand

Emplacement du menu
Menu → Sousmenu → Texte de menu pour la commande
Ateliers
Nom de l'atelier
Raccourci par défaut
F C
Introduit dans la version
0.19
Voir aussi
Aucun

Description

Tant que la page est en construction, ajoutez le modèle Template:UnfinishedDocu en haut de la page en tapant simplement : {{UnfinishedDocu}}.

Dans ce premier paragraphe, donnez une brève description de ce que fait la commande. La description peut faire référence à d'autres ateliers tels que l' Atelier Sketcher. (Note de l'éditeur: L'image fait 24px, pas 16px)

N'oubliez pas d'utiliser Template:Version, Template:VersionMinus, Template:VersionPlus et Template:Obsolete le cas échéant.

Par exemple : La fonction App::Link (introduit dans la version 0.19) permet de créer des liens entre les sous-ensembles, etc...

Ajoutez une image si possible et suivez les instructions de Ecrire une page Wiki. Exemple tiré de Part Balayage :

Facultatif : ajoutez une légende sous l'image pour expliquer le fonctionnement de l'outil.

La fermeture et l’ouverture des balises de traduction doivent entourer les images et d’autres éléments fixes, s’ils ne nécessitent pas de traduction. La légende doit toujours être traduite.

Utilisation

  1. Il existe plusieurs façons de lancer la commande:
    • Appuyez sur le bouton Base ExampleCommandModel. (Note de l'éditeur: Ceci utilise le modèle Template:Button, il est nécessaire de créer un lien vers la commande comme indiqué dans cet exemple)
    • Sélectionnez l'option Menu → Sous-menu → Texte du menu de la commande dans le menu. (Note de l'éditeur: Ceci utilise le modèle Template: MenuCommand)
    • Sélectionnez l'option Submenu → Texte du menu de la commande dans le menu contextuel Vue en arborescence ou Vue 3D. (Note de l'éditeur: Ceci utilise également le modèle Template:MenuCommand, toutes les commandes ne sont pas accessibles à partir d'un menu contextuel)
    • Utilisez le raccourci clavier F puis C ou Ctrl + Z. (Note de l'éditeur: Ceci utilise le modèle Template:KEY, toutes les commandes n'ont pas de raccourci clavier)
  2. Étapes détaillées au besoin. Certaines étapes peuvent nécessiter Keyboard pressions tandis que d'autres peuvent nécessiter l'utilisation de la souris pour cliquer sur un Button.
  3. Définissez les options et appuyez sur OK.

Options

Exemple

Optionnel.

Remarques

Propriétés

Voir aussi : Éditeur de propriétés

Un objet est généralement dérivé d'un objet de base. Vous ne devez pas énumérer les propriétés qui sont héritées de cet objet de base. Voir par exemple Draft Polyligne.

Données

Property Group

Vue

Property Group

Script

Voir aussi: Autogenerated API documentation et Débuter avec les scripts FreeCAD.

L'outil ExampleCommandModel peut être utilisé dans une macro et depuis la console Python en utilisant la fonction suivante : 

Object = makeExampleCommandModel(Data1, Data2)

Exemple : 

import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)

Autre

Optionnel.

Bloc sélectionnable

<languages/>
{{UnfinishedDocu}}
<translate>

{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}

{{GuiCommand
|Name=Base ExampleCommandModel
|Icon= <!--filename of icon with extension (e.g. svg, png) if not the same name as command-->
|MenuLocation=Menu → Submenu → Menu text for the command
|Workbenches=[[Workbench_Name|Workbench]]
|Shortcut={{KEY|F}} {{KEY|C}}
|Version=0.19
|SeeAlso= <!--add links to similar commands and related pages-->
}}

== Description ==

While the page is under construction, add the [[Template:UnfinishedDocu]] template at the top of the page by simply typing: '''{{UnfinishedDocu}}'''

In this first paragraph give a short description of what the command does. The description can refer to other workbenches such as the [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|Sketcher Workbench]]. (''Editor note:'' The image is 24px, not 16px)

Remember to use [[Template:Version]], [[Template:VersionMinus]], [[Template:VersionPlus]] and [[Template:Obsolete]] when applicable.

For example: The {{incode|App::Link}} feature ({{Version|0.19}}) allows linking between sub-assemblies etc...

Add an image if possible, and please follow the guidelines in [[WikiPages#Graphics|WikiPages]]. Example taken from [[Part_Sweep|Part Sweep]]:
</translate>
[[Image:Part_Sweep_simple.png|none]]
<translate>
{{Caption|Optional: add a caption below the image to explain what the tool does}}

Closing and opening translate tags should surround images, and other fixed elements, if they don't need to be translated. The caption should always be translated.

== Usage ==

# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Std_Open.svg|16px]] [[GuiCommand_model|Base ExampleCommandModel]]}} button. (''Editor note:'' This uses the [[Template:Button]] template, it is necessary to link to the command as shown in this example)
#* Select the {{MenuCommand|Menu → Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the menu. (''Editor note:'' This uses the [[Template:MenuCommand]] template)
#* Select the {{MenuCommand|Submenu → [[Image:Std_Open.svg|16px]] Menu text for the command}} option from the [[Tree_view|Tree view]] context menu or [[3D_view|3D view]] context menu. (''Editor note:'' This also uses the [[Template:MenuCommand]] template, not all commands can be accessed from a context menu)
#* Use the keyboard shortcut {{KEY|F}} then {{KEY|C}} or {{KEY|Ctrl}}+{{KEY|Z}}. (''Editor note:'' This uses the [[Template:KEY]] template, not all commands have a keyboard shortcut)
# Detailed steps as needed. Some steps may need {{KEY|Keyboard}} presses while others may require using the mouse to click on a {{Button|Button}}.
# Set options and press {{Button|OK}}.

== Options ==

* Optional. List the command options here. See for example [[Draft_Wire|Draft Wire]].

== Example ==

Optional.

== Notes ==

* Optional. Use a bullet list if there are multiple items. You can also mention limitations here.

== Properties ==

See also: [[Property_editor|Property editor]].

An object is usually derived from a base object. You should not list the properties that are inherited from that base object. See for example [[Draft_Wire#Properties|Draft Wire]].

=== Data ===

{{TitleProperty|Property Group}}

* {{PropertyData|Property Name 1|PropertyType}}: Description of the property. (''Editor note:'' to find the {{Value|PropertyType}} select {{MenuCommand|Show all}} in the context menu of the [[Property_editor|Property editor]]. The tooltip of each property will then include this information. But the {{Value|PropertyType}} can also be found in the source code.)

=== View ===

{{TitleProperty|Property Group}}

* {{PropertyView|Property Name 2|PropertyType}}: Description of the property.

== Scripting ==

See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

The ExampleCommandModel tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following function:

</translate>
{{Code|code=
Object = makeExampleCommandModel(Data1, Data2)
}}
<translate>

* Creates an {{incode|Object}} using {{incode|Data1}} and {{incode|Data2}}.

Example:

</translate>
{{Code|code=
import FreeCAD, Base

Model = Base.makeExampleCommandModel(FreeCAD.Data1, FreeCAD.Data2)
}}
<translate>

== Other ==

Optional.


{{Docnav
|[[Base_PreviousCommand|PreviousCommand]]
|[[Base_NextCommand|NextCommand]]
|[[Workbench_Name|Workbench]]
|IconL= <!--filename of icon with extension (e.g. svg, png)-->
|IconR= <!--filename of icon with extension (e.g. svg, png)-->
|IconC= <!--filename of icon with extension (e.g. svg, png)-->
}}

</translate>
{{Workbench_Tools_navi{{#translation:}}}} <!--use the Tools navi belonging to the workbench -->
{{Userdocnavi{{#translation:}}}}


Commande avant
Commande après
Atelier

Template:Workbench Tools navi/fr

Hub utilisateurs